/*
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Original Code is iSQL-Viewer, A Mutli-Platform Database Tool.
 *
 * The Initial Developer of the Original Code is iSQL-Viewer, A Mutli-Platform Database Tool.
 * Portions created by Mark A. Kobold are Copyright (C) 2000-2007. All Rights Reserved.
 *
 * Contributor(s): 
 *  Mark A. Kobold [mkobold <at> isqlviewer <dot> com].
 *  
 * If you didn't download this code from the following link, you should check
 * if you aren't using an obsolete version: http://www.isqlviewer.com
 */
package org.isqlviewer.util;

import org.apache.log4j.Logger;

/**
 * Utility base class for providing logging support as part of the class itself.
 * <p>
 * Point of this is simple; and that is to make logging information via log4j easier
 * 
 * @author Mark A. Kobold &lt;mkobold at isqlviewer dot com&gt;
 * @version 1.0
 */
public abstract class LoggableObject {

    private Logger logger = Logger.getLogger(getClass());

    /**
     * Logs informational error and supplementary message.
     * <p>
     * if informational messages are enabled the message and exception will be logged to designated destination.
     * 
     * @param message informational message to log.
     * @param error exception associated with the message.
     */
    protected final void info(Object message, Throwable error) {

        if (logger.isInfoEnabled()) {
            logger.info(message, error);
        }
    }

    /**
     * Logs an informational message.
     * <p>
     * if informational loggins is enabled the message will be logged to designated destination.
     * 
     * @param message informational message to log.
     */
    protected final void info(Object message) {

        if (logger.isInfoEnabled()) {
            logger.info(message);
        }
    }

    /**
     * Logs debugging messages and supplementary exception.
     * <p>
     * if debug messages are enabled the message and exception will be logged to designated destination.
     * 
     * @param message debug message to log.
     * @param error exception associated with the message.
     */
    protected final void debug(Object message, Throwable error) {

        if (logger.isDebugEnabled()) {
            logger.debug(message, error);
        }
    }

    /**
     * Logs message for debugging purposes.
     * <p>
     * if debugging is enabled the message will be logged to designated destination.
     * 
     * @param message debug information to log.
     */
    protected final void debug(Object message) {

        if (logger.isDebugEnabled()) {
            logger.debug(message);
        }
    }

    /**
     * Logs error messages and supplementary exception.
     * <p>
     * if error messages are enabled the message and exception will be logged to designated destination.
     * 
     * @param message error message to log.
     * @param error exception associated with the message.
     */
    protected final void error(Object message, Throwable error) {

        logger.error(message, error);
    }

    /**
     * Logs an error message.
     * <p>
     * if error logging is enabled the message will be logged to designated destination.
     * 
     * @param message error message to log.
     */
    protected final void error(Object message) {

        logger.error(message);
    }

    /**
     * Logs warning messages and supplementary exception.
     * <p>
     * 
     * @param message warning message to log.
     * @param error exception associated with the message.
     */
    protected final void warn(Object message, Throwable error) {

        logger.warn(message, error);
    }

    /**
     * Logs warning messages.
     * <p>
     * 
     * @param message warning information to log.
     */
    protected final void warn(Object message) {

        logger.warn(message);
    }

}
